AtomicX Core API/io.trtc.tuikit.atomicxcore.api.live

Package-level declarations

Types

BattleConfig

data class BattleConfig(var duration: Int = 0, var needResponse: Boolean = false, var extensionInfo: String = "")

PK configuration information set when sending PK request

BattleEndedReason

enum BattleEndedReason : Enum<BattleEndedReason>

Reason for users in PK to receive PK ended notification

BattleInfo

data class BattleInfo(val battleID: String = "", val config: BattleConfig = BattleConfig(), val startTime: Long = 0, val endTime: Long = 0)

PK information

BattleListener

abstract class BattleListener

Callback events related to PK.

BattleRequestCallback

interface BattleRequestCallback

PK request callback

BattleState

data class BattleState(var currentBattleInfo: StateFlow<BattleInfo?>, var battleUsers: StateFlow<List<SeatUserInfo>>, var battleScore: StateFlow<Map<String, Int>>)

PK related state data provided by BattleStore.

BattleStore

abstract class BattleStore

Anchor PK management class

CoGuestState

data class CoGuestState(val connected: StateFlow<List<SeatUserInfo>>, val invitees: StateFlow<List<LiveUserInfo>>, val applicants: StateFlow<List<LiveUserInfo>>, val candidates: StateFlow<List<LiveUserInfo>>)

Co-hosting related state data provided by CoGuestStore

CoGuestStore

abstract class CoGuestStore

Audience co-hosting management class

CoHostLayoutTemplate

enum CoHostLayoutTemplate : Enum<CoHostLayoutTemplate>

Connection layout template

CoHostListener

abstract class CoHostListener

Callback events for connection requests.

CoHostState

data class CoHostState(val coHostStatus: StateFlow<CoHostStatus>, val connected: StateFlow<List<SeatUserInfo>>, val invitees: StateFlow<List<SeatUserInfo>>, val applicant: StateFlow<SeatUserInfo?>, candidates: StateFlow<List<SeatUserInfo>>)

Cross-room connection related state data provided by CoHostStore

CoHostStatus

enum CoHostStatus : Enum<CoHostStatus>

Cross-room connection status of current user

CoHostStore

abstract class CoHostStore

Anchor connection management class

DeviceControlPolicy

enum DeviceControlPolicy : Enum<DeviceControlPolicy>

Device control policy

GuestListener

abstract class GuestListener

Callback events received by audience side

HostListener

abstract class HostListener

Callback events received by anchor side

LikeListener

abstract class LikeListener

Like event, used to receive like dynamics in live rooms/voice chat rooms.

LikeState

data class LikeState(val totalLikeCount: StateFlow<Long>)

Like state, used to display and subscribe to like information in live rooms/voice chat rooms.

LikeStore

abstract class LikeStore

Like management class, used to handle like-related business logic in live rooms/voice chat rooms.

LiveAudienceListener

abstract class LiveAudienceListener

Live audience event

LiveAudienceState

data class LiveAudienceState(val audienceList: StateFlow<List<LiveUserInfo>>, val audienceCount: StateFlow<Int>)

Live audience state

LiveAudienceStore

abstract class LiveAudienceStore

Live audience management class, used to manage audience list, permission settings and other related business.

LiveCanvas

data class LiveCanvas(var w: Int = 0, var h: Int = 0, var templateID: Int = 600)

Live canvas

LiveEndedReason

enum LiveEndedReason : Enum<LiveEndedReason>

Live ended reason.

LiveInfo

data class LiveInfo(var liveID: String = "", var liveName: String = "", var notice: String = "", var isMessageDisable: Boolean = false, var isPublicVisible: Boolean = true, var isSeatEnabled: Boolean = true, var keepOwnerOnSeat: Boolean = false, var maxSeatCount: Int = 0, var seatMode: TakeSeatMode = TakeSeatMode.APPLY, var seatLayoutTemplateID: Int = 600, var coverURL: String = "", var backgroundURL: String = "", var categoryList: List<Int> = emptyList(), var activityStatus: Int = 0, val liveOwner: LiveUserInfo = LiveUserInfo(), val createTime: Long = 0, var totalViewerCount: Int = 0, var isGiftEnabled: Boolean = true, var metaData: Map<String, String> = emptyMap())

Live information

LiveInfoCompletionHandler

interface LiveInfoCompletionHandler

Metadata completion callback closure.

LiveKickedOutReason

enum LiveKickedOutReason : Enum<LiveKickedOutReason>

Reason for being kicked out of live room.

LiveListListener

abstract class LiveListListener

Live list event

LiveListState

data class LiveListState(val liveList: StateFlow<List<LiveInfo>>, val liveListCursor: StateFlow<String>, val currentLive: StateFlow<LiveInfo>)

Live list state

LiveListStore

abstract class LiveListStore

Live room list management class, used to manage live room related business.

LiveSeatListener

abstract class LiveSeatListener

Seat related callback events.

LiveSeatState

data class LiveSeatState(val seatList: StateFlow<List<SeatInfo>>, val canvas: StateFlow<LiveCanvas>, val speakingUsers: StateFlow<MutableMap<String, Int>>)

Seat state data provided by LiveSeatStore.

LiveSeatStore

abstract class LiveSeatStore

Live seat management class

LiveSummaryData

data class LiveSummaryData(var totalDuration: Long = 0, var totalViewers: Int = 0, var totalGiftsSent: Int = 0, var totalGiftUniqueSenders: Int = 0, var totalGiftCoins: Int = 0, var totalLikesReceived: Int = 0, var totalMessageSent: Int = 0)

LiveSummaryState

data class LiveSummaryState(val summaryData: StateFlow<LiveSummaryData>)

LiveSummaryStore

abstract class LiveSummaryStore

LiveUserInfo

data class LiveUserInfo(var userID: String = "", var userName: String = "", var avatarURL: String = "")

Live user information

MetaDataCompletionHandler

interface MetaDataCompletionHandler

MoveSeatPolicy

enum MoveSeatPolicy : Enum<MoveSeatPolicy>

Move seat policy

NoResponseReason

enum NoResponseReason : Enum<NoResponseReason>

Reason for no response to co-hosting invitation sent by anchor or co-hosting request initiated by audience

RegionInfo

data class RegionInfo(var x: Int = 0, var y: Int = 0, var w: Int = 0, var h: Int = 0, var zorder: Int = 0)

Seat view coordinate information

Role

enum Role : Enum<Role>

User role.

SeatInfo

data class SeatInfo(var index: Int = 0, var isLocked: Boolean = false, var userInfo: SeatUserInfo = SeatUserInfo(), var region: RegionInfo = RegionInfo())

Seat information

SeatUserInfo

data class SeatUserInfo(val userID: String = "", val userName: String = "", val avatarURL: String = "", val role: Role = Role.GENERAL_USER, val liveID: String = "", val microphoneStatus: DeviceStatus = DeviceStatus.OFF, val allowOpenMicrophone: Boolean = true, val cameraStatus: DeviceStatus = DeviceStatus.OFF, val allowOpenCamera: Boolean = true)

Seat user information

StopLiveCompletionHandler

interface StopLiveCompletionHandler

TakeSeatMode

enum TakeSeatMode : Enum<TakeSeatMode>

Take seat mode.